home *** CD-ROM | disk | FTP | other *** search
/ Aminet 25 / Aminet 25 (1998)(GTI - Schatztruhe)[!][Jun 1998].iso / Aminet / util / rexx / ECompile.lha / ECompile / ReadMe.txt < prev   
Text File  |  1998-04-20  |  6KB  |  196 lines
  1.  
  2. ECompile.ced v2.11 - AmigaE compiler script for Cygnus Editor!
  3.  
  4.  
  5. WHAT IS SO SPECIAL ABOUT IT?
  6.  
  7. · It uses reqtools.library for output results ie. compile status.
  8. · Can make duplicates ie. makes a copy of the compiled file into
  9.   another drawer. (configurable)
  10. · Can save backups of source file. (requester option)
  11. · Autoupdates versionstring (configurable)
  12. · You are asked to add a versionstring if none was found! (configurable)
  13. · And it's really simple to use...
  14.  
  15.  
  16. SPECIAL FEATURES?
  17.  
  18. · You can specify duplicate path inside each source
  19. · You can specify EC options inside each source
  20. · You can handle version strings inside source
  21.  
  22.  
  23. HOW DO I INSTALL IT?
  24.  
  25. Just place the script in 'Rexx:'
  26. And then put it as a hotkey in Cygnus Editor!
  27.  
  28.  
  29. HOW DO I PUT THE SCRIPT AS A HOTKEY IN CYGNUS EDITOR?
  30.  
  31. 1. Go to Cygnus Editor menu option "Special-Dos/Arexx interface"
  32. 2. Choose Fkey to have compiler on (1-10)
  33. 3. Write the name of the script 'ECompile.ced'
  34. 4. Now you can start compiling :)
  35.  
  36.  
  37. CAN'T FIND AMIGAE COMPILER?
  38.  
  39. Change ECPath inside script!
  40.  
  41.  
  42. WANT A AMIGAE COMPILER OPTION TO ALWAYS BE USED?
  43.  
  44. Change default ECOptions inside script!
  45. This way you don't have to write it inside the sources!
  46.  
  47.  
  48. HOW DO I USE SPECIAL FEATURES?
  49.  
  50. IMPORTANT! Always write these options DIRECT INTO THE ARROW (i.e. NO SPACE)!!!
  51. List of options:
  52.  
  53. ->ECOptions EC options
  54. ->ECDupPath "Path to the duplicate"
  55. ->ECNoVer
  56. ->ECNoBump
  57. ->ECBumpRev
  58. ->ECComment "comment to place after verstring in the filenote"
  59. ->ECPPSet
  60. #define ECVERNAME 'programname'
  61. #define ECVERSHORT 'ver.rev'
  62. #define ECVERLONG 'ver.rev.fixrev'
  63. #define ECVERDATE '(d.m.yy)'
  64.  
  65.  
  66. The two first are separate from the rest which are for versionstrings.
  67.  
  68. Compile handling (both can be used at the same time):
  69. · ECOptions - With this you can specify EC options inside your source.
  70.               Remove if no options should be used (or default from script)!
  71. · ECDupPath - With this a cloned copy of the compiled file can be placed
  72.               anywhere you want.  Do not use it for no clone!
  73.  
  74. Version string handling:
  75. · NoVer     - No change to or adding of versionstring will be done.
  76. · NoBump    - No change of the actual version number is done but date will
  77.               be changed.
  78. · BumpRev   - Increases revision number by one on each compile
  79. · <nothing> - Increases beta revision number by one on each compile
  80. One of these four can only be used at the same time!
  81.  
  82. Additional commands & version handling:
  83. · ECComment - Adds the verstring as a filenote to the compiled exe
  84.               Additional text to be added as filenote can be written
  85.               after this command. Note, verstring will ALWAYS be added!
  86. · ECPPSet   - Tells the compiler script to use the defines.
  87.               Compiler option OPT PREPROCESS is necessary because define
  88.               is used...
  89.  
  90. These four defines are usable! All defines must not be used at the same time!
  91. NEVER use more than ONE space between a define and the string!!!
  92. ECVERNAME 'programname'
  93. ECVERSHORT 'ver.rev'
  94. ECVERLONG 'ver.rev.fixrev'
  95. ECVERDATE '(d.m.yy)'
  96.  
  97. If you don't want to use any of these features..
  98. Then simply don't write anything!!!  A requester will appear anyway so you
  99. can choose some of these options even if no option was used!
  100.  
  101. Example source:
  102. -------------------------------------------------------------------------------
  103. /*  Example program  */
  104.  
  105. ->ECOptions OPTI LARGE           /* uses EC options 'OPTI' & 'LARGE'! */
  106. ->ECDupPath "Work:OwnPrograms/"  /* Clones compiled file to this path */
  107. ->ECBumpRev                      /* Bumps the rev number! */
  108. ->ECComment " © 1997 by me!"     /* Adds verstring & comment to filenote */
  109. ->ECPPSet                        /* Uses the verstring defines */
  110. #define ECVERNAME 'Example'
  111. #define ECVERSHORT '1.0'
  112. #define ECVERDATE '(11.8.97)'
  113.  
  114. OPT OSVERSION=37,PREPROCESS
  115.  
  116. PROC main()
  117.    PrintF('\nHello World\n\nVer: \s \s \s\n\n',ECVERNAME,ECVERSHORT,ECVERDATE)
  118. ENDPROC
  119.  
  120. VOID '$VER: Example 1.0 (11.8.97) © 1997 by me!'
  121. -------------------------------------------------------------------------------
  122.  
  123.  
  124. LOOK OF VERSION STRING:
  125.  
  126. The line made in the source will look like this:
  127.  
  128. VOID '$VER: Sourcename 1.0 (11.8.97)'
  129.  
  130. And will be placed LAST in your source!
  131. Of course will ECompiler.ced update a verstring in ANY place!!!
  132.  
  133. Beta revisions look like this:
  134.  
  135. VOID '$VER: Sourcename 1.0.1 (11.8.97)'
  136.  
  137.  
  138. WHAT IS THE REQUIREMENTS?
  139.  
  140. · Cygnus Editor v3+ (v4.xx+ rek.)
  141. · ARexx v1.15+
  142. · ReqTools.library v38+
  143. · RexxReqTools.library v37+
  144. · AmigaE Compiler v3.0+
  145. · AmigaOS v2.04+ (v37)
  146. · C:Filenote, C:Copy
  147.  
  148.  
  149. CONTACTING THE AUTHOR!
  150.  
  151. For bug reports etc. write an e-mail to:
  152.  
  153. Writer of current version (complete rewrite) Johan Nilsson:
  154. jonils@algonet.se
  155.  
  156. Writer of original version, this doc & beta testing Harry Samwel:
  157. samwel@algonet.se
  158.  
  159.  
  160. HISTORY
  161.  
  162.  1.0-1.3 -  Internal versions
  163.      1.4 -  Fixed a couple of bugs
  164.             Added saving backup of sourcefile
  165.             Optimized code
  166.  1.5-2.1 -  Internal versions
  167.      2.2 -  Fixed a couple of bugs
  168.             Changed finding/output of error codes from EC
  169.             Added version string handling
  170.             Additional changes
  171.  2.3-2.4 -  Internal changes
  172.             Some small fixes
  173.             Added comments handling for verstrings
  174.             Changed backup handling (now a filerequester)
  175.      2.5 -  Changed outlook of requester output
  176.      2.6 -  Added option to make defines of the verstring
  177.      2.7 -  Optimized define handling
  178.      2.8 -  Optimized define handling even more
  179.             Changed backup handling (now a 'overwrite' requester)
  180.      2.9 -  Fixed some problems with the define handling
  181.             Added a BumpFix button
  182.             Added a help page button
  183.     2.10 -  Added centered screen repositioning when jumping back to
  184.             where cursor was when starting compile script
  185.     2.11 -  Fixed to work with NEW CygnusEd 4.xx
  186.  
  187.  
  188. COPYRIGHTS
  189.  
  190. CygnusEditor is Copyright © 1987-1998 CygnusSoft Software
  191. ARexx & AmigaOS is Copyright © 1985-1998 Amiga International
  192. ReqTools.library is Copyright © 1991-1994 Nico Francios
  193. ReqTools.library is Copyright © 1996-1998 Magnus Holmgren
  194. RexxReqTools.library is Copyright © 1992-1994 Rafael D'halleweyn
  195. AmigaE/AmigaE Compiler is Copyright © 1991-1998 Wouter van Oortmerssen
  196.